类 FoxitPDFSDKPython3.Screen 继承关系图:

Public 成员函数
def	Screen ()
	构造函数。

def	Screen (annot)
	构造函数，使用父类对象。更多...

def	GetAction ()
	获取动作。更多...

def	GetBitmap ()
	从当前屏幕注释获取位图。更多...

def	GetMKDict ()
	获取外观特征字典（也称为"MK"字典）。更多...

def	GetOpacity ()
	获取不透明度值。更多...

def	GetRotation ()
	获取用于当前屏幕注释外观的图像旋转。更多...

def	GetTitle ()
	获取当前屏幕注释的标题。更多...

def	RemoveAction ()
	移除动作。更多...

def	SetAction (action)
	设置动作。更多...

def	SetImage (image, frame_index, compress)
	为当前屏幕注释设置图像，使用指定的帧索引。更多...

def	SetMKDict (dict)
	设置外观特征字典（也称为"MK"字典）。更多...

def	SetOpacity (opacity)
	设置不透明度值。更多...

def	SetRotation (rotate)
	设置用于当前屏幕注释外观的图像旋转。更多...

def	SetTitle (title)
	设置当前屏幕注释的标题。更多...

Public 成员函数继承自 FoxitPDFSDKPython3.Annot
def	Annot (page, annot_dict)
	构造函数，使用PDF页面和注释的PDF字典。更多...

def	Annot (annot)
	构造函数，使用另一个注释对象。更多...

def	Annot ()
	构造函数。

def	GetAppearanceStream (type, appearance_state)
	获取具有指定类型和状态的注释外观流。更多...

def	GetBorderColor ()
	获取边框颜色。更多...

def	GetBorderInfo ()
	获取边框信息。更多...

def	GetContent ()
	获取内容。更多...

def	GetDeviceRect (matrix)
	获取设备坐标系统中的注释矩形。更多...

def	GetDict ()
	获取注释的字典对象。更多...

def	GetDisplayMatrix (page_display_matrix)
	获取显示矩阵，从到目标设备坐标系统。更多...

def	GetFlags ()
	获取注释标志。更多...

def	GetIndex ()
	获取当前注释在其所属页面中的索引。更多...

def	GetModifiedDateTime ()
	获取最后修改日期时间。更多...

def	GetOptionalContent ()
	获取注释可选内容的PDF字典。更多...

def	GetPage ()
	获取相关的PDF页面。更多...

def	GetRect ()
	获取矩形，以表示。更多...

def	GetType ()
	获取当前注释的实际注释类型。更多...

def	GetUniqueID ()
	获取唯一ID。更多...

def	HasProperty (property)
	当前注释是否具有指定的注释属性。更多...

def	IsEmpty ()
	检查当前对象是否为空。更多...

def	IsMarkup ()
	检查当前注释是否为标记注释。更多...

def	Move (rect)
	将当前注释移动到新位置，由中的新矩形指定。更多...

def	Move (rect, is_reset_appearance)
	将当前注释移动到新位置，由中的新矩形指定。更多...

def	RemoveProperty (property)
	删除指定的注释属性。更多...

def	ResetAppearanceStream ()
	重置外观流。更多...

def	SetBorderColor (color)
	设置边框颜色。更多...

def	SetBorderInfo (border)
	设置边框信息。更多...

def	SetContent (content)
	设置内容。更多...

def	SetFlags (flags)
	设置注释标志。更多...

def	SetModifiedDateTime (date_time)
	设置最后修改日期时间。更多...

def	SetUniqueID (unique_id)
	设置唯一ID。更多...

额外继承的成员函数
静态 Public 属性继承自 FoxitPDFSDKPython3.Annot
	e_3D = _fsdk.Annot_e_3D
	注释类型：3D注释。<PDF参考1.7>中的标准注释之一。

	e_AppearanceTypeDown = _fsdk.Annot_e_AppearanceTypeDown
	注释的按下外观。

	e_AppearanceTypeNormal = _fsdk.Annot_e_AppearanceTypeNormal
	注释的正常外观。

	e_AppearanceTypeRollover = _fsdk.Annot_e_AppearanceTypeRollover
	注释的悬停外观。

	e_Caret = _fsdk.Annot_e_Caret
	注释类型：插入符注释。<PDF参考1.7>中的标准注释之一。

	e_Circle = _fsdk.Annot_e_Circle
	注释类型：圆形注释。<PDF参考1.7>中的标准注释之一。

	e_FileAttachment = _fsdk.Annot_e_FileAttachment
	注释类型：文件附件注释。<PDF参考1.7>中的标准注释之一。

	e_FlagHidden = _fsdk.Annot_e_FlagHidden
	注释标志：隐藏。更多...

	e_FlagInvisible = _fsdk.Annot_e_FlagInvisible
	注释标志：不可见。更多...

	e_FlagLocked = _fsdk.Annot_e_FlagLocked
	注释标志：锁定。更多...

	e_FlagLockedContents = _fsdk.Annot_e_FlagLockedContents
	注释标志：锁定内容。更多...

	e_FlagNoRotate = _fsdk.Annot_e_FlagNoRotate
	注释标志：无旋转。更多...

	e_FlagNoView = _fsdk.Annot_e_FlagNoView
	注释标志：无视图。更多...

	e_FlagNoZoom = _fsdk.Annot_e_FlagNoZoom
	注释标志：无缩放。更多...

	e_FlagPrint = _fsdk.Annot_e_FlagPrint
	注释标志：打印。更多...

	e_FlagReadOnly = _fsdk.Annot_e_FlagReadOnly
	注释标志：只读。更多...

	e_FlagToggleNoView = _fsdk.Annot_e_FlagToggleNoView
	注释标志：切换无视图。更多...

	e_FreeText = _fsdk.Annot_e_FreeText
	注释类型：自由文本注释。<PDF参考1.7>中的标准注释之一。

	e_Highlight = _fsdk.Annot_e_Highlight
	注释类型：高亮注释。<PDF参考1.7>中的标准注释之一。

	e_HighlightingInvert = _fsdk.Annot_e_HighlightingInvert
	高亮模式：反转，即反转注释矩形的内容。

	e_HighlightingNone = _fsdk.Annot_e_HighlightingNone
	高亮模式：无高亮。

	e_HighlightingOutline = _fsdk.Annot_e_HighlightingOutline
	高亮模式：轮廓，即反转注释的边框。

	e_HighlightingPush = _fsdk.Annot_e_HighlightingPush
	高亮模式：按下，即显示注释的按下外观（如果有）。

	e_HighlightingToggle = _fsdk.Annot_e_HighlightingToggle
	高亮模式：切换。这仅对小组件注释有用。

	e_Ink = _fsdk.Annot_e_Ink
	注释类型：墨迹注释。<PDF参考1.7>中的标准注释之一。

	e_Line = _fsdk.Annot_e_Line
	注释类型：直线注释。<PDF参考1.7>中的标准注释之一。

	e_Link = _fsdk.Annot_e_Link
	注释类型：链接注释。<PDF参考1.7>中的标准注释之一。

	e_MKEntryBackgroundColor = _fsdk.Annot_e_MKEntryBackgroundColor
	背景颜色条目。MK字典中的"BG"。

	e_MKEntryBorderColor = _fsdk.Annot_e_MKEntryBorderColor
	边框颜色条目。MK字典中的"BC"。

	e_MKEntryDownCaption = _fsdk.Annot_e_MKEntryDownCaption
	按下标题（或备用标题）条目。MK字典中的"AC"。更多...

	e_MKEntryDownIcon = _fsdk.Annot_e_MKEntryDownIcon
	按下图标（或备用图标）条目。MK字典中的"IX"。更多...

	e_MKEntryIconCaptionRelation = _fsdk.Annot_e_MKEntryIconCaptionRelation
	图标和标题关系条目。MK字典中的"TP"。更多...

	e_MKEntryIconFit = _fsdk.Annot_e_MKEntryIconFit
	图标适配信息条目。MK字典中的"IF"。更多...

	e_MKEntryNormalCaption = _fsdk.Annot_e_MKEntryNormalCaption
	正常标题条目。MK字典中的"CA"。更多...

	e_MKEntryNormalIcon = _fsdk.Annot_e_MKEntryNormalIcon
	正常图标条目。MK字典中的"I"。更多...

	e_MKEntryRolloverCaption = _fsdk.Annot_e_MKEntryRolloverCaption
	悬停标题条目。MK字典中的"RC"。更多...

	e_MKEntryRolloverIcon = _fsdk.Annot_e_MKEntryRolloverIcon
	悬停图标条目。MK字典中的"RI"。更多...

	e_MKEntryRotation = _fsdk.Annot_e_MKEntryRotation
	旋转条目。MK字典中的"R"。

	e_MKRelationCaptionAboveIcon = _fsdk.Annot_e_MKRelationCaptionAboveIcon
	标题在图标上方。

	e_MKRelationCaptionBelowIcon = _fsdk.Annot_e_MKRelationCaptionBelowIcon
	标题在图标下方。

	e_MKRelationCaptionLeft = _fsdk.Annot_e_MKRelationCaptionLeft
	标题在图标左侧。

	e_MKRelationCaptionOvrlayOnIcon = _fsdk.Annot_e_MKRelationCaptionOvrlayOnIcon
	标题直接覆盖在图标上。

	e_MKRelationCaptionRight = _fsdk.Annot_e_MKRelationCaptionRight
	标题在图标右侧。

	e_MKRelationNoCaption = _fsdk.Annot_e_MKRelationNoCaption
	无标题；仅图标。

	e_MKRelationNoIcon = _fsdk.Annot_e_MKRelationNoIcon
	无图标；仅标题。

	e_Movie = _fsdk.Annot_e_Movie
	注释类型：电影注释。<PDF参考1.7>中的标准注释之一。

	e_Note = _fsdk.Annot_e_Note
	注释类型：注记注释，即"文本"注释 - <PDF参考1.7>中的标准注释之一。

	e_PagingSeal = _fsdk.Annot_e_PagingSeal
	注释类型：分页印章注释。福昕PDF SDK自定义注释类型（非标准注释类型）。

	e_Polygon = _fsdk.Annot_e_Polygon
	注释类型：多边形注释。<PDF参考1.7>中的标准注释之一。

	e_PolyLine = _fsdk.Annot_e_PolyLine
	注释类型：折线注释。<PDF参考1.7>中的标准注释之一。

	e_Popup = _fsdk.Annot_e_Popup
	注释类型：弹出注释。<PDF参考1.7>中的标准注释之一。

	e_PrinterMark = _fsdk.Annot_e_PrinterMark
	注释类型：印刷标记注释。<PDF参考1.7>中的标准注释之一。

	e_PropertyBorderColor = _fsdk.Annot_e_PropertyBorderColor
	注释属性：边框颜色。更多...

	e_PropertyCreationDate = _fsdk.Annot_e_PropertyCreationDate
	注释属性：创建日期。更多...

	e_PropertyFillColor = _fsdk.Annot_e_PropertyFillColor
	注释属性：填充颜色更多...

	e_PropertyModifiedDate = _fsdk.Annot_e_PropertyModifiedDate
	注释属性：修改日期。

	e_PSInk = _fsdk.Annot_e_PSInk
	注释类型：压力敏感墨迹注释。

	e_Redact = _fsdk.Annot_e_Redact
	注释类型：编辑注释。

	e_RichMedia = _fsdk.Annot_e_RichMedia
	注释类型：富媒体注释。

	e_Screen = _fsdk.Annot_e_Screen
	注释类型：屏幕注释。<PDF参考1.7>中的标准注释之一。

	e_Sound = _fsdk.Annot_e_Sound
	注释类型：声音注释。<PDF参考1.7>中的标准注释之一。

	e_Square = _fsdk.Annot_e_Square
	注释类型：矩形注释。<PDF参考1.7>中的标准注释之一。

	e_Squiggly = _fsdk.Annot_e_Squiggly
	注释类型：波浪线注释。<PDF参考1.7>中的标准注释之一。

	e_Stamp = _fsdk.Annot_e_Stamp
	注释类型：印章注释。<PDF参考1.7>中的标准注释之一。

	e_StrikeOut = _fsdk.Annot_e_StrikeOut
	注释类型：删除线注释。<PDF参考1.7>中的标准注释之一。

	e_TrapNet = _fsdk.Annot_e_TrapNet
	注释类型：陷阱网络注释。<PDF参考1.7>中的标准注释之一。

	e_Underline = _fsdk.Annot_e_Underline
	注释类型：下划线注释。<PDF参考1.7>中的标准注释之一。

	e_UnknownType = _fsdk.Annot_e_UnknownType
	注释类型：未知。

	e_Watermark = _fsdk.Annot_e_Watermark
	注释类型：水印注释。<PDF参考1.7>中的标准注释之一。

	e_Widget = _fsdk.Annot_e_Widget
	注释类型：小组件注释。<PDF参考1.7>中的标准注释之一。更多...

详细描述

屏幕注释指定页面上可以播放媒体剪辑的区域。它还作为可以触发动作的对象。通常，演出动作被设置给屏幕注释，以便屏幕注释可以用于播放媒体剪辑。
类FoxitPDFSDKPython3.Screen 派生自Annot ，并提供获取/设置链接注释属性和重置屏幕注释外观流的函数。屏幕注释的外观流用于打印（如果可能）以及当相关媒体剪辑未播放时。

注解: 对于新创建的屏幕注释，它没有边框信息和边框颜色。

参见: Annot

构造及析构函数说明

◆ Screen()

def FoxitPDFSDKPython3.Screen.Screen ( annot )

构造函数，使用父类对象。

参数

[in] annot 父类对象。

成员函数说明

◆ GetAction()

def FoxitPDFSDKPython3.Screen.GetAction ( )

获取动作。

此函数不能用于获取用作附加动作的动作。如果用户想要获取任何附加动作，请参考类FoxitPDFSDKPython3.AdditionalAction 了解更多详细信息。

返回: 接收动作数据的动作对象。如果返回的动作对象的函数 FoxitPDFSDKPython3.Action.IsEmpty 的返回值为true，那意味着没有动作。

◆ GetBitmap()

def FoxitPDFSDKPython3.Screen.GetBitmap ( )

从当前屏幕注释获取位图。

返回: 位图对象。如果返回的位图对象的函数FoxitPDFSDKPython3.Bitmap.IsEmpty 的返回值为true，那意味着当前屏幕注释没有位图。

◆ GetMKDict()

def FoxitPDFSDKPython3.Screen.GetMKDict ( )

获取外观特征字典（也称为"MK"字典）。

如果此字典未设置给屏幕注释（包括当前注释），请调用函数FoxitPDFSDKPython3.PDFObject.Release （从FoxitPDFSDKPython3.PDFDictionary 的父类继承）来释放它。

返回: 表示"MK"字典的PDF字典。如果没有"MK"条目或发生任何错误，此函数将返回null。

◆ GetOpacity()

def FoxitPDFSDKPython3.Screen.GetOpacity ( )

获取不透明度值。

此属性对注释的外观有影响。

返回: 不透明度值。有效范围：0.0到1.0。 0.0表示完全透明，1.0表示完全不透明。

◆ GetRotation()

def FoxitPDFSDKPython3.Screen.GetRotation ( )

获取用于当前屏幕注释外观的图像旋转。

返回: 图像的旋转值。请参考从FoxitPDFSDKPython3.e_Rotation0 开始的值，这将是这些值中的一个。

◆ GetTitle()

def FoxitPDFSDKPython3.Screen.GetTitle ( )

获取当前屏幕注释的标题。

返回: 标题字符串。

◆ RemoveAction()

def FoxitPDFSDKPython3.Screen.RemoveAction ( )

移除动作。

此函数不能用于移除用作附加动作的动作。如果用户想要移除任何附加动作，请参考类FoxitPDFSDKPython3.AdditionalAction 了解更多详细信息。

返回: 无。

◆ SetAction()

def FoxitPDFSDKPython3.Screen.SetAction ( action )

设置动作。

此函数不能用于设置用作附加动作的动作。如果用户想要设置任何附加动作，请参考类FoxitPDFSDKPython3.AdditionalAction 了解更多详细信息。

参数

[in] action 要设置的新动作。它应该是有效的。目前只支持以下类型作为新动作：
FoxitPDFSDKPython3.Action.e_TypeGoto 、 FoxitPDFSDKPython3.Action.e_TypeURI 、 FoxitPDFSDKPython3.Action.e_TypeJavaScript 、 FoxitPDFSDKPython3.Action.e_TypeNamed 、 FoxitPDFSDKPython3.Action.e_TypeGoToR 、 FoxitPDFSDKPython3.Action.e_TypeGoToE 、 FoxitPDFSDKPython3.Action.e_TypeSubmitForm 、 FoxitPDFSDKPython3.Action.e_TypeResetForm 、 FoxitPDFSDKPython3.Action.e_TypeHide 、 FoxitPDFSDKPython3.Action.e_TypeLaunch 、 FoxitPDFSDKPython3.Action.e_TypeImportData 、 FoxitPDFSDKPython3.Action.e_TypeRendition 。

返回: 无。

◆ SetImage()

def FoxitPDFSDKPython3.Screen.SetImage	(	image,
		frame_index,
		compress
	)

为当前屏幕注释设置图像，使用指定的帧索引。

输入图像可能包含多个帧，只有图像的一个帧可以设置给当前屏幕注释。
如果用户希望效果显示在注释的外观中，请在此函数后调用函数 FoxitPDFSDKPython3.Annot.ResetAppearanceStream 。

参数

[in]	image	图像。其中一个帧将被设置给当前屏幕。此图像至少包含一个帧，且图像类型不应为 FoxitPDFSDKPython3.Image.e_Unknown 。
[in]	frame_index	帧索引。有效范围：从0到（count-1）。 count由函数FoxitPDFSDKPython3.Image.GetFrameCount 返回。
[in]	compress	用于压缩图像数据的压缩算法类型。目前，它只支持2个有效值： 0：不压缩。 1：执行默认压缩。

返回: 无。

◆ SetMKDict()

def FoxitPDFSDKPython3.Screen.SetMKDict ( dict )

设置外观特征字典（也称为"MK"字典）。

参数

[in] dict 表示要设置的新"MK"字典的PDF字典。用户在将其设置给屏幕注释后不应释放此字典。

◆ SetOpacity()

def FoxitPDFSDKPython3.Screen.SetOpacity ( opacity )

设置不透明度值。

此属性对注释的外观有影响。如果用户希望效果显示在注释的外观中，请在此函数后调用函数FoxitPDFSDKPython3.Annot.ResetAppearanceStream 。

参数

[in] opacity 新的不透明度值。有效范围：0.0到1.0。 0.0表示完全透明，1.0表示完全不透明。

返回: 无。

◆ SetRotation()

def FoxitPDFSDKPython3.Screen.SetRotation ( rotate )

设置用于当前屏幕注释外观的图像旋转。

此属性对注释的外观有影响。如果用户希望效果显示在注释的外观中，请在此函数后调用函数FoxitPDFSDKPython3.Annot.ResetAppearanceStream 。

参数

[in] rotate 旋转值。请参考从FoxitPDFSDKPython3.e_Rotation0 开始的值，这应该是这些值中的一个，除了FoxitPDFSDKPython3.e_RotationUnknown 。

返回: 无。

◆ SetTitle()

def FoxitPDFSDKPython3.Screen.SetTitle ( title )

设置当前屏幕注释的标题。

参数

[in] title 要设置的标题字符串。

返回: 无。

Public 成员函数

额外继承的成员函数

详细描述

构造及析构函数说明

◆ Screen()

成员函数说明

◆ GetAction()

◆ GetBitmap()

◆ GetMKDict()

◆ GetOpacity()

◆ GetRotation()

◆ GetTitle()

◆ RemoveAction()

◆ SetAction()

◆ SetImage()

◆ SetMKDict()

◆ SetOpacity()

◆ SetRotation()

◆ SetTitle()